<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>EDS API: eds::arch::ReportFunction Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">EDS API
   </div>
   <div id="projectbrief">Enterprise Data Server Application Programming Interface</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classeds_1_1arch_1_1_report_function.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classeds_1_1arch_1_1_report_function-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">eds::arch::ReportFunction Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Represents a report function with its parameters.  
 <a href="classeds_1_1arch_1_1_report_function.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_arch_client_8h_source.html">ArchClient.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:adfdd3b916031be903e944d784b127ebd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeds_1_1arch_1_1_report_function.html#adfdd3b916031be903e944d784b127ebd">pushPointParam</a> (int sid, unsigned char bits_filter=0xFF, unsigned char shade_mode=ShadeMode_PreferRegular)</td></tr>
<tr class="memdesc:adfdd3b916031be903e944d784b127ebd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pushes a point argument to function.  <a href="#adfdd3b916031be903e944d784b127ebd"></a><br/></td></tr>
<tr class="memitem:a3c9b8836cc15f17eb0612ea7aa261a45"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeds_1_1arch_1_1_report_function.html#a3c9b8836cc15f17eb0612ea7aa261a45">pushTimestampParam</a> (std::time_t ts)</td></tr>
<tr class="memdesc:a3c9b8836cc15f17eb0612ea7aa261a45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pushes a timestamp argument to function.  <a href="#a3c9b8836cc15f17eb0612ea7aa261a45"></a><br/></td></tr>
<tr class="memitem:a221d6870d08aef0efda41c691651a128"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeds_1_1arch_1_1_report_function.html#a221d6870d08aef0efda41c691651a128">pushValueParam</a> (double v)</td></tr>
<tr class="memdesc:a221d6870d08aef0efda41c691651a128"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pushes a floating point (double) argument to function.  <a href="#a221d6870d08aef0efda41c691651a128"></a><br/></td></tr>
<tr class="memitem:afbd32008f7c56e37570d3a46b5a2c7c4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeds_1_1arch_1_1_report_function.html#afbd32008f7c56e37570d3a46b5a2c7c4">clearParams</a> ()</td></tr>
<tr class="memdesc:afbd32008f7c56e37570d3a46b5a2c7c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes all pushed arguments from function.  <a href="#afbd32008f7c56e37570d3a46b5a2c7c4"></a><br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Represents a report function with its parameters. </p>
<p>Depending on their type (<em>VALUE</em>, <em>AVG</em>, etc.) report functions expect different number and types of parameters. Please consult EDS Terminal documentation for more information on function arguments. </p>
</div><h2>Member Function Documentation</h2>
<a class="anchor" id="adfdd3b916031be903e944d784b127ebd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void eds::arch::ReportFunction::pushPointParam </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>sid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned char&#160;</td>
          <td class="paramname"><em>bits_filter</em> = <code>0xFF</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned char&#160;</td>
          <td class="paramname"><em>shade_mode</em> = <code><a class="el" href="namespaceeds_1_1arch.html#a32e2fe0d83ab8f76bae8606995802373a7dfe4c28bb1e82c47a370c8ea6c976ca">ShadeMode_PreferRegular</a></code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Pushes a point argument to function. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">sid</td><td>- server identifier of point. Server identifiers can be obtained using <a class="el" href="classeds_1_1live_1_1_live_client.html#a3d9c9f50ca89e68c16843d298e85ace3" title="Returns server identifier of point.">eds::live::LiveClient::pointSID()</a> method. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">bits_filter</td><td>- when other than 0xFF, enables bit filter. Bit filter only works for PACKED and BINARY points. It rejects all archive values which do not have the <code>bits_filter</code> bit set. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">shade_mode</td><td>- specifies preference for regular archive values or shades </td></tr>
  </table>
  </dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>EDS 7.3 </dd></dl>

</div>
</div>
<a class="anchor" id="a3c9b8836cc15f17eb0612ea7aa261a45"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void eds::arch::ReportFunction::pushTimestampParam </td>
          <td>(</td>
          <td class="paramtype">std::time_t&#160;</td>
          <td class="paramname"><em>ts</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Pushes a timestamp argument to function. </p>
<dl class="section since"><dt>Since</dt><dd>EDS 7.3 </dd></dl>

</div>
</div>
<a class="anchor" id="a221d6870d08aef0efda41c691651a128"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void eds::arch::ReportFunction::pushValueParam </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>v</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Pushes a floating point (double) argument to function. </p>
<dl class="section since"><dt>Since</dt><dd>EDS 7.3 </dd></dl>

</div>
</div>
<a class="anchor" id="afbd32008f7c56e37570d3a46b5a2c7c4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void eds::arch::ReportFunction::clearParams </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Removes all pushed arguments from function. </p>
<dl class="section since"><dt>Since</dt><dd>EDS 7.3 </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespaceeds.html">eds</a></li><li class="navelem"><a class="el" href="namespaceeds_1_1arch.html">arch</a></li><li class="navelem"><a class="el" href="classeds_1_1arch_1_1_report_function.html">ReportFunction</a></li>
    <li class="footer">Generated on Tue Jul 31 2012 17:22:09 for EDS API by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.2 </li>
  </ul>
</div>
</body>
</html>
